Add best practice note about version #9700
Conversation
Adding this info based on request by @nicolas-grekas in #27037 (symfony/symfony#27037)
components/phpunit_bridge.rst
Outdated
|
|
||
| .. best-practice:: | ||
|
|
||
| PHPUnit Bridge is designed to remain compatible with Symfony version 2.7 up to master, |
There was a problem hiding this comment.
Not sure we should tell about 2.7: it's being EOLed in a few weeks. Maybe something like that instead?
The PHPUnit bridge is designed to work with all maintained versions of Symfony components, even across different major versions of them. You should always use its very latest stable major version to get the most accurate deprecation reports.
There was a problem hiding this comment.
Maybe also, the line above "$ composer require --dev symfony/phpunit-bridge" should be updated to
$ composer require --dev "symfony/phpunit-bridge:*"
|
@nicolas-grekas, I updated the PR to implement your edit |
This PR was merged into the master branch. Discussion ---------- Allow any versions of the phpunit bridge Following the advice in symfony/symfony-docs#9700 Commits ------- 22a2677 Allow any versions of the phpunit bridge
components/phpunit_bridge.rst
Outdated
|
|
||
| The PHPUnit bridge is designed to work with all maintained versions of Symfony components, | ||
| even across different major versions of them. You should always use its very latest stable | ||
| major version to get the most accurate deprecation report |
There was a problem hiding this comment.
Missing dot at end of line.
|
hey @nicolas-grekas, sorry about the missing period. I tried adding it and pushing it to my fork's PR branc, but it didn't get automatically ingested here. Is there something else I need to do, or will someone else fix that? |
|
I can see the dot here now, all good on my side, thank you very much. |
|
Thanks for this contribution Philip! We merged it on the 2.7 branch and we replaced the "best practice" directive by a "note" because the best practice is reserved for the "Symfony Best Practices" book (https://symfony.com/doc/current/best_practices/index.html), but other than that, it was a great first Symfony Docs contribution. Thanks! |
…luz) This PR was submitted for the 4.0 branch but it was merged into the 2.7 branch instead (closes #9700). Discussion ---------- Add best practice note about version Adding this info based on request by @nicolas-grekas in [#27037](symfony/symfony#27037) <!-- If your pull request fixes a BUG, use the oldest maintained branch that contains the bug (see https://symfony.com/roadmap for the list of maintained branches). If your pull request documents a NEW FEATURE, use the same Symfony branch where the feature was introduced (and `master` for features of unreleased versions). --> Commits ------- 6082b97 Minor tweak 9ecff4b components/phpunit_bridge.rst cd7fd94 Add best practice note about version
Adding this info based on request by @nicolas-grekas in #27037